Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve init containers concept page #14281

Merged
merged 2 commits into from
Jul 11, 2019
Merged

Improve init containers concept page #14281

merged 2 commits into from
Jul 11, 2019

Conversation

sftim
Copy link
Contributor

@sftim sftim commented May 11, 2019 •
edited
Loading

Improve https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
fixes #9272

  • Init containers are stable since v1.6; make that clear via a feature-state shortcode
    • and drop advice about migrating from older syntax
  • Replace “Container” with “container” as it's not a Kubernetes object (unlike, say, Pod)
  • Use glossary references where appropriate
    • I didn't add container as a glossary reference because I'm assuming that any reader unfamiliar with containers would first come across the Pod definition, which links appropriately.
  • Add a what's next link to Debug Init Containers
  • General rewording
  • Use shell code formatting for shell examples

In this PR I haven't moved YAML examples outside of the docs. If that's something we want, I'd recommend doing that in a separate PR (see issue #12740).

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 11, 2019
@netlify
Copy link

netlify bot commented May 11, 2019 •
edited
Loading

Deploy preview for kubernetes-io-master-staging ready!

Built with commit c42207e

https://deploy-preview-14281--kubernetes-io-master-staging.netlify.com

@sftim
Copy link
Contributor Author

sftim commented May 11, 2019

This should help with #9272

@sftim sftim force-pushed the 20190511_improve_init_containers branch from 2ec4548 to 8114260 Compare May 28, 2019 13:58
@sftim sftim force-pushed the 20190511_improve_init_containers branch from 8114260 to e280bb9 Compare June 10, 2019 11:57
@sftim sftim force-pushed the 20190511_improve_init_containers branch from 438682f to 45e7a56 Compare June 11, 2019 10:16
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 25, 2019
@sftim sftim force-pushed the 20190511_improve_init_containers branch from 45e7a56 to 9d0c594 Compare June 25, 2019 18:44
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 25, 2019
@sftim
Copy link
Contributor Author

sftim commented Jun 25, 2019

Rebase & reworded.

@sftim
Copy link
Contributor Author

sftim commented Jun 25, 2019

/assign @zacharysarah

@zacharysarah
Copy link
Contributor

@sftim 👋

This should help with #9272

Awesome! ✨ Please edit this PR description to include a line that says fixes #9272 or closes #9272. "Fixes" and "closes" are GitHub magic words that will automatically close the issue when the PR merges.

zacharysarah
zacharysarah suggested changes Jul 4, 2019
View reviewed changes
Copy link
Contributor

@zacharysarah zacharysarah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sftim Thank you so much for this! ✨ I left some edits, mostly for clarity and removing the passive voice.

content/en/docs/concepts/workloads/pods/init-containers.md
A [Pod](/docs/concepts/workloads/pods/pod-overview/) can have multiple Containers running
apps within it, but it can also have one or more Init Containers, which are run
before the app Containers are started.
## Understanding init containers
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent de-capitalization. 👍

content/en/docs/concepts/workloads/pods/init-containers.md Outdated Show resolved Hide resolved
content/en/docs/concepts/workloads/pods/init-containers.md Outdated Show resolved Hide resolved
content/en/docs/concepts/workloads/pods/init-containers.md Outdated Show resolved Hide resolved
content/en/docs/concepts/workloads/pods/init-containers.md Outdated Show resolved Hide resolved
content/en/docs/concepts/workloads/pods/init-containers.md Outdated Show resolved Hide resolved
content/en/docs/concepts/workloads/pods/init-containers.md Outdated Show resolved Hide resolved
content/en/docs/concepts/workloads/pods/init-containers.md Outdated Show resolved Hide resolved
content/en/docs/concepts/workloads/pods/init-containers.md Outdated Show resolved Hide resolved
content/en/docs/concepts/workloads/pods/init-containers.md Outdated Show resolved Hide resolved
@sftim sftim changed the title Improve init containers concept page [WIP] Improve init containers concept page Jul 11, 2019
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 11, 2019
@sftim sftim force-pushed the 20190511_improve_init_containers branch from 9d0c594 to c1daa84 Compare July 11, 2019 23:19
sftim added 2 commits July 12, 2019 00:20
@sftim
Improve init containers page
5fd5e1c 
- Overall rewording
- Link to “Debug init containers” in whatsnext
- Explain terms / use glossary references
- Use glossary shortcodes where appropriate
- Expand terms like QoS and cgroup that aren't in the glossary
- Only document & recommend stable syntax
- Tweak initContainer examples to use project style
- Drop vestigialreference to StatefulSet

Also: write “container” in lower case

Most of the places where this page talks about containers, it's as a
concept rather than an object in the Kubernetes API. Adjust case
accordingly.
@sftim
Reword what's next section
c42207e
@sftim sftim force-pushed the 20190511_improve_init_containers branch from c1daa84 to c42207e Compare July 11, 2019 23:20
@sftim sftim changed the title [WIP] Improve init containers concept page Improve init containers concept page Jul 11, 2019
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 11, 2019
@sftim
Copy link
Contributor Author

sftim commented Jul 11, 2019

@zacharysarah thank you for the very clear and relevant feedback.

[I think] I have adopted all the suggestions you made and this is ready to review once again.

@zacharysarah
Copy link
Contributor

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 11, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zacharysarah

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 11, 2019
@k8s-ci-robot k8s-ci-robot merged commit e1ec9a6 into kubernetes:master Jul 11, 2019
@sftim sftim deleted the 20190511_improve_init_containers branch July 11, 2019 23:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tengqm tengqm tengqm requested changes

@zacharysarah zacharysarah zacharysarah requested changes

@erictune erictune Awaiting requested review from erictune

@stewart-yu stewart-yu Awaiting requested review from stewart-yu

Assignees

@zacharysarah zacharysarah

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Issue with k8s.io/docs/concepts/workloads/pods/init-containers/
4 participants
@sftim @zacharysarah @k8s-ci-robot @tengqm